Carbon


GetControlAction

Header: Controls.h Carbon status: Supported

Returns a pointer to the action function stored in the contrlAction field of the control structure.

ControlActionUPP GetControlAction (
    ControlRef theControl
);
theControl

A handle to a control.

function result

The value stored in the contrlAction field of the control structure. This field specifies the action function that the functions HandleControlClick and TrackControl use if you set the InAction parameter to (ControlActionUPP)-1. See ControlActionProcPtr for an example of an action function.0

DISCUSSION

The action function returned by the GetControlAction function defines an action to take in response to a mouse button being held down while the cursor is in the control. An action function is usually specified in the InAction parameter of the functions HandleControlClick and TrackControl. You can use the function SetControlAction to change the action function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)